home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / sfued105.zip / README17.SFU < prev    next >
Text File  |  1991-12-06  |  14KB  |  259 lines
  1.  
  2.               StormFront User Editor for the Opus-CBCS
  3.                      Programmed by Kevin Silcox
  4.  
  5.                                                        December 6, 1991
  6.  
  7. Disclaimer
  8. ----------
  9.     This software is available "AS IS".  It is not guaranteed to work at
  10. all. If it trashes your system or ruins your life, you have been warned.
  11. I am not responsible for any damages incurred from the use or misuse of
  12. this software.  There is also no fee to use this software.
  13.  
  14.     You will have to get by without any real documentation until I, or
  15. someone else write some for this program.  If you know Opus and how it
  16. works, then this program should be pretty much self-explanatory as far
  17. as what the actual changes to the user database do.  So for now, there's
  18. only a brief description of how to use the actual functions of the program.
  19. Even though SFUE isn't the most user-friendly program, I think that its
  20. flexibility and simplicity (well, in some ways) is worth the struggle
  21. you may go through when you first start to use it.  Enjoy!
  22.  
  23. -------------------------------------------------
  24.   This version: 1.05  --->  For Opus v1.7x
  25.   **-- Version numbers with a lowercase letter are beta versions. --**
  26.  
  27.     Requires approximately 80K of Available RAM.  Requires
  28.     more if using the Sort option (based on number of records
  29.     in your database --> about 28 bytes for each record).
  30.  
  31.     This program is for maintaining the user database used with
  32. Opus.  It is capable of adding users to the USER.DAT file, marking
  33. them to be ReUsed, Purged, Normal, and even Removing users marked
  34. to be Purged (Zap), along with many other features.
  35.  
  36.     The program accepts a command-line argument for local and non-
  37. local use.  The arguments are as follows: -M for Mono, -C for Color,
  38. -D for DOS Output, -B for BIOS Writes, -Z to Zap the database, or
  39. -F to specify which User Database file to use.
  40.     The -M and -C options are only to force the memory address for the
  41. direct-screen writes if the program doesn't recognize the correct video
  42. mode.  If no arguments are entered, the program will AutoDetect which
  43. video mode to use for the direct-screen writes.  Entering an argument
  44. other than those arguments listed will display a brief help screen.
  45.     The -F allows you to specify the name of the User Database file
  46. that you want to use instead of the default USER.DAT.  If you specify
  47. just the full path without a filename, USER.DAT will be assumed (you
  48. must have a "\" after the path though).
  49.  
  50. **==--==**
  51.     In the lower right-hand corner of the User Screen are the commands
  52. that are available in all ScreenSections.  Below is a brief description
  53. of what they do:
  54.  
  55.     R)  Record Number:  This allows you to go to a specific record number
  56.         within the database.
  57.     !)  User Status:  This allows you to modify the status of a user's
  58.         record.  The Status can be one of the following:
  59.             Normal: This is a normal record.
  60.             Reuse : As new users are added, they will be placed in records
  61.                      marked with this status instead of being added to the
  62.                      end of the database.
  63.             Purge : This means that if you use the Zap function, the record
  64.                      will be removed from the database.  Also used by OMAN.
  65.         Update ID : This will update the caller ID number but should only be
  66.                      used if the caller_ID is all zero's.
  67.     *)  Utilities:   This is for maintaining the database.  These are:
  68.             Adduser: If you need to add a user, this is what you'll use.
  69.                       It has gives you the option of just adding a record
  70.                       at the end of the database, or searching for a record
  71.                       marked with the "Reuse" status.  If you choose to
  72.                       search for a record to Reuse, and there is a record
  73.                       marked with the Reuse status, then that record will be
  74.                       cleared of its information and you may start entering
  75.                       the new user information in that record.
  76.             Global : Allows you to make certain changes to specific (or all)
  77.                       users.  You may specify to set only a certain privilege
  78.                       level, or the default is all records (record #1 will
  79.                       NOT be touched).  There are also sub-levels that I
  80.                       don't have time to go into.
  81.                       -=***=-
  82.                       I feel that the options for changing Keys and Sections
  83.                       may cause some confusion.  With those two options there
  84.                       are 4 sub-options [Exact/Set/Toggle/Unselect]:
  85.  
  86.                         Exact:    Set each user to exactly the keys you
  87.                                   specify.  If you only select the 'A' key,
  88.                                   that's the only key the users' will have
  89.                                   no matter what they started out with.
  90.                         Set:      All keys you specify will be turned ON for
  91.                                   each user.
  92.                         Toggle:   Exactly what it says...  If you select the 'A'
  93.                                   key each users' keys will be set to the
  94.                                   opposite it started out as.
  95.                         Unselect: The opposite of Set.  It will make sure each
  96.                                   key you select is turned OFF.
  97.  
  98.  
  99.             Search : This allows you to search certain fields for a string.
  100.                       It's useful for finding a specific user quickly among
  101.                       other things.
  102.             sOrt   : This will sort your database based on the keys you
  103.                       select, and whether you select Ascending or Descending
  104.                       order for each key.  You may select up to two keys to
  105.                       sort by.
  106.                       ** The sort is currently limited to about 1000 records
  107.                          maximum until I get the time to write a different
  108.                          sort routine other than the internal qsort(). **
  109.             sWap   : This allows you to swap any two records with each other.
  110.             Report : This generates a report for all users and sends it either
  111.                       to the Screen, Printer, or a File.  You can Pause the
  112.                       output by pressing 'P', or have an option to Abort by
  113.                       pressing 'ESC'.  You are asked several questions about
  114.                       how the report should be, but I don't have the time to
  115.                       go into detail explaining it...
  116.             Zap    : This removes any records marked with the Purge status.
  117.                       Also you can specify the number of days a user can go
  118.                       without calling the system before he/she is removed from
  119.                       the database.  This option is also available from the
  120.                       command-line.  By default a file called USER.SAV will
  121.                       be used to place any deleted records into.  Currently
  122.                       the only way for you to put a user from the USER.SAV
  123.                       file back into the USER.DAT file is something like:
  124.                         COPY /B USER.DAT+USER.SAV USER.DAT
  125.                       That should re-build the database.
  126.  
  127.   +/-)  Change Record Number:  You can use either the plus and minus keys
  128.                                 to increment/decrement the record number
  129.                                 respectively, or use the left and right arrow
  130.                                 keys to do the same thing.  Home and End
  131.                                 will place you at the first and last records
  132.                                 respectively.
  133.   ESC)  Quit:   If you have made any changes to the current record without
  134.                  going to another record, you will be asked if you want to
  135.                  save the user information before exiting.  Anytime you
  136.                  change to another record, the current record is saved to
  137.                  disk if it has been modified.
  138. SPACE)  (SpaceBar) ScrnSect:    Changes the current Screen Section.  The
  139.                                  active ScrnSect is displayed at the top of
  140.                                  the screen.  The Screen Sections are at the
  141.                                  left side of each box border.  A ScrnSect
  142.                                  must be active in order for its commands
  143.                                  to be active.  Also when a ScrnSect is
  144.                                  active, the number next to the active box
  145.                                  will BLINK.
  146.                                 The ScrnSect can also be changed with the up
  147.                                  and down arrow keys to decrement/increment
  148.                                  the ScrnSect number respectively.
  149.  
  150.    F9)  DOS Shell:  Exactly what it says.  The User Editor is NOT swapped
  151.                      out of memory.
  152. **==--==**
  153.  
  154.     I hope this is enough of a program description to get you familiar with
  155. the program.  For Opus v1.7x the ScrnSect is not the same as the "Section" in
  156. Opus.
  157.     Currently this Editor doesn't contain an internal index updating function.
  158. You will need to use the USERNDX program that is distributed with Opus v1.7x.
  159. The Editor will call USERNDX when exiting whenever it thinks the Index needs
  160. to be updated.  USERNDX will only be called when you have made changes inside
  161. the Editor that might change the NDX file.  USERNDX must either be located in
  162. the PATH, or in the same directory as your user database, or in your Opus Home
  163. Directory.
  164. ------------------------------------------------------
  165.  
  166. ***********************
  167. * Report Information: *
  168. ***********************
  169.  
  170. **
  171. Level of Detail Grouping (80-column output):
  172. ------------------------------------------------------
  173. 1:
  174.  A = User Record Number                 (Width =  5)
  175.  B = User Name                          (Width = 26)
  176.  C = Phone Number                       (Width = 15)
  177.  D = City, State                        (Width = 25)
  178. --
  179. 2:
  180.  E = Street Address                     (Width = 26)
  181.  F = Answer to SysOp Question           (Width = 43)
  182. --
  183. 3:
  184.  G = SysOp Comment                      (Width = 44)
  185.  H = Birthdate                          (Width =  9)
  186.  I = Access Privilege                   (Width =  9)
  187. --
  188. 4:
  189.  J = Keys                               (Width = 32)
  190.  K = Download:Upload Ratio              (Width =  9)
  191.  L = Days Since Last Call               (Width =  4)
  192.  M = Password (optional)                (Width = 15)
  193.  
  194. ------------------------------------------------------
  195.  
  196. **
  197. Level of Detail Grouping (132-column output):
  198. ------------------------------------------------------
  199. 1:
  200.  A = User Record Number                 (Width =  5)
  201.  B = User Name                          (Width = 26)
  202.  C = Phone Number                       (Width = 15)
  203.  D = City, State                        (Width = 25)
  204.  E = Street Address                     (Width = 25)
  205.  F = Alias                              (Width = 20)
  206. --
  207. 2:
  208.  G = Answer to SysOp Question           (Width = 44)
  209.  H = SysOp Comment                      (Width = 45)
  210.  I = Birthdate                          (Width =  9)
  211.  J = Password (optional)                (Width = 15)
  212. --
  213. 3:
  214.  K = Access Privilege                   (Width =  9)
  215.  L = Keys                               (Width = 32)
  216.  M = Download:Upload Ratio              (Width =  9)
  217.  N = Days Since Last Call               (Width =  4)
  218.  O = First Call to System               (Width = 11)
  219.  
  220. ------------------------------------------------------
  221.  
  222.  
  223. ------------------------------------------------------
  224.  
  225.     Thank You for taking your time to read this, and use my program.
  226. If you have any comments or suggestions, I'd like to hear from you.
  227. Please contact me if you have any problems with the program, or you
  228. would like to see any added features.  You may contact me (via NetMail)
  229. at the phone number (or FidoNet Address) listed below.  I also read the
  230. NEWOPUS and MEADOW Echo's.  The latest version of my software is also
  231. available on my BBS.  It may be requested with the magic name of "SFUE17"
  232. for the Opus 1.7x version, and "SFUE11" for the Opus 1.1x version.
  233.  
  234.                                 --=={ Kevin Silcox ------
  235.                                 SysOp of:
  236.                                     The StormFront BBS
  237.                                     in Orangevale, California
  238.                                     (916) 988-0407
  239.                                     FidoNet (1:203/407.0)
  240.  
  241.                                 BBS Hours:
  242.                                     Conditionally 23 hours a day,
  243.                                       but definately between:
  244.                                       11:00 p.m. and 11:00 a.m
  245.                                     excluding National Mail Hour:
  246.                                       1:00 a.m to 2:00 a.m PST
  247.  
  248.     Since this phone number is also my voice number for now, there may be
  249. times when I pick up the phone instead of the computer.  If this happens
  250. I'll immediately try to force the BBS to answer the phone so you don't
  251. have to call back.  I'll try to make the line busy whenever I'm doing
  252. something on the computer that would prevent me from forcing the BBS to
  253. answer.  Have fun!
  254.  
  255.     Special Thanks to my Beta Test Team for making suggestions that have
  256. increased the power (and flexibility) of SFUE, and especially for finding
  257. those little critters that lurk around in most software!
  258.  
  259.